Repository navigation
Clarify definition of native and implicit namespace packages - #1979
Conversation
|
Something that occurred to me while reviewing the complementary PR at #1882 is that it would make sense to mutually cross link the new glossary entry with the more detailed description at |
Add a seealso directive for native namespace packages per pypa#1979 (comment)
Done in eae76d7 |
|
Spoke too soon. I assumed there was an existing target, so I added one in bd73c03. Sorry for the noise. There's still our little friend at: causing this warning: It appears that that page no longer exists in the setuptools docs. I made a guess with a0c8b87. That appears to have resolved both issues. |
rgommers
left a comment
There was a problem hiding this comment.
I merged main, resolving the merge conflict which removed the unrelated change to cross-link the setuptools docs (that sentence had been deleted in main already).
#1882 added a straightforward entry for "Namespace Package" into the glossary. What this PR adds is more detail; that should live on the full page on namespace packages, which already have a lot of detail but are missing this terminology indeed.
In my opinion, no new glossary entry for "Implicit Namespace Package" and ""Native Namespace Package" should be added, that's too niche, and duplicate with the full page. And even if we wanted that, the amount of content added for the glossary entries is way too long.
I suggest to keep the changes to packaging-namespace-packages.rst, and cross-link that from the glossary entry for "Namespace Package", possibly with a "native"/"implicit" mention.
It'd also be good to squash all commits when that is done.
|
I'm not altogether clear. Do you mean move the content from the glossary entry into |
|
Yes indeed. This PR adds a Then add a link to that page from the current "Namespace Package" package, adding say one sentence to that entry. Remove the new glossary entry that's in this PR right now. |
Explain that native and implicit namespace packages are the same PEP 420 mechanism, and describe both terms in the namespace packaging guide. Keep the detailed terminology on the guide page rather than adding separate glossary entries.
…sentence Point readers to the namespace packaging guide for the native and legacy approaches, keeping the glossary definition concise. The sentence on PEP 420 and Python 3.3 is already present in the numbered list right above, so remove it - this also makes the added .. note:: more concise.
rgommers
left a comment
There was a problem hiding this comment.
Thanks @stevepiercy. the cross-reference from the glossary was still missing, so I added that. Also, the "PEP 420 .... Python 3.3" statement was already present right above the new .. note::, so I removed that. With that, it should be good to go now - so in it goes.
Thanks @stevepiercy, and thanks to all reviewers.
This pull request clarifies the definition of native and implicit namespace packages as synonyms, and adds a glossary term for them.
From a discussion in Discord at https://discord.com/channels/935215565872693329/935215566334079058/1451178701956976853, by an initially very confused reader who's relatively new to the terminology.
Feedback welcome. Thank you for your consideration.
📚 Documentation preview 📚: https://python-packaging-user-guide--1979.org.readthedocs.build/en/1979/